/* 
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.  
*/
package erwiki.part.rendering.internal.parser;

import java.io.IOException;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Map;
import java.util.NoSuchElementException;

import org.apache.log4j.Logger;
import org.apache.oro.text.regex.MatchResult;
import org.apache.oro.text.regex.PatternMatcher;
import org.apache.oro.text.regex.Perl5Matcher;
import org.jdom2.Text;

import erwiki.api.core.Engine;
import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.InternalWikiException;
import erwiki.api.exceptions.PluginException;
import erwiki.api.parser.WikiDocument;
import erwiki.api.plugin.ParserStagePlugin;
import erwiki.api.plugin.PluginElement;
import erwiki.api.plugin.PluginManager;
import erwiki.api.plugin.WikiPlugin;
import erwiki.api.preferences.Preferences;
import erwiki.api.rwc.RWC;
import erwiki.api.variables.VariableManager;

/**
 * Stores the contents of a plugin in a WikiDocument DOM tree.
 * <p/>
 * If the Context.VAR_WYSIWYG_EDITOR_MODE is set to Boolean.TRUE in the context, then the plugin is
 * rendered as WikiMarkup. This allows an HTML editor to work without rendering the plugin each time
 * as well.
 * <p/>
 * If Context.VAR_EXECUTE_PLUGINS is set to Boolean.FALSE, then the plugin is not executed.
 */
public class PluginContent extends Text implements PluginElement {

	private static final long serialVersionUID = 1L;

	private static final Logger log = Logger.getLogger(PluginContent.class);

	private static final String BLANK = "";
	private static final String CMDLINE = "_cmdline";
	private static final String ELEMENT_BR = "<br/>";
	private static final String EMITTABLE_PLUGINS = "Image|FormOpen|FormClose|FormInput|FormTextarea|FormSelect";
	private static final String LINEBREAK = "\n";
	private static final String PLUGIN_START = "[{";
	private static final String PLUGIN_END = "}]";
	private static final String SPACE = " ";

	private String m_pluginName;
	private Map<String, String> m_params;

	/**
	 * Creates a new DOM element with the given plugin name and a map of parameters.
	 *
	 * @param pluginName The FQN of a plugin.
	 * @param parameters A Map of parameters.
	 */
	public PluginContent(String pluginName, Map<String, String> parameters) {
		m_pluginName = pluginName;
		m_params = parameters;
	}

	/** {@inheritDoc} */
	@Override
	public String getPluginName() {
		return m_pluginName;
	}

	/** {@inheritDoc} */
	@Override
	public String getParameter(String name) {
		return m_params.get(name);
	}

	/** {@inheritDoc} */
	@Override
	public Map<String, String> getParameters() {
		return m_params;
	}

	/** {@inheritDoc} */
	@Override
	public String getValue() {
		return getText();
	}

	/** {@inheritDoc} */
	@Override
	public String getText() {
		WikiDocument doc = (WikiDocument) getDocument();
		if (doc == null) {
			/// Этот элемент еще никуда не прикреплен, поэтому просто предполагаем,
			/// что рендеринга нет, и возвращаем имя плагина.
			/// Это необходимо, например. когда paragraphify() проверяет,
			/// пуст ли элемент или нет.
			/// Мы, конечно, не можем знать приведет ли рендеринг к пустой строке
			/// или нет, но предположим, что это не так.
			return getPluginName();
		}

		/* Осуществляет вызов плагина и возвращает его содержимое.
		 */
		WikiContext wikiContext = RWC.INSTANCE;
		Engine engine = wikiContext.getEngine();
		VariableManager variableManager = engine.getManager(VariableManager.class);
		PluginManager pluginManager = engine.getManager(PluginManager.class);

		String result;
		Boolean wysiwygVariable = wikiContext.getVariable(WikiContext.VAR_WYSIWYG_EDITOR_MODE);
		boolean wysiwygEditorMode = false;
		if (wysiwygVariable != null) {
			wysiwygEditorMode = wysiwygVariable;
		}

		try {
			// Определить для этого плагина:
			// - опубликовать ли фактический код вызова
			// - или надо вызвать его выполнение.
			// Замечание: Некоторые плагины всегда вызываются,
			// поскольку их можно редактировать визуально.
			//
// FIXME: Сопоставление имен плагинов должно выполняться не здесь, а в ресурсе, отдельном для каждого редактора.
			if (wysiwygEditorMode && !m_pluginName.matches(EMITTABLE_PLUGINS)) {
				result = PLUGIN_START + m_pluginName + SPACE;

				// преобразовать переводы строк в <br>, если у плагина есть тело.
				String cmdLine = m_params.get(CMDLINE).replaceAll(LINEBREAK, ELEMENT_BR);
				result = result + cmdLine + PLUGIN_END;
			} else {
				Boolean b = wikiContext.getVariable(WikiContext.VAR_EXECUTE_PLUGINS);
				if (b != null && !b) {
					return BLANK;
				}

				Map<String, String> parsedParams = new HashMap<>();

				// Выполнить подстановку для всех экземпляров переменных,
				// заданных в декларации плагина на странице.
				for (Map.Entry<String, String> e : m_params.entrySet()) {
					String val = e.getValue();
					val = variableManager.expandVariables(val);
					parsedParams.put(e.getKey(), val);
				}
				result = pluginManager.execute(wikiContext, m_pluginName, parsedParams);
			}
		} catch (Exception e) {
			if (wysiwygEditorMode) {
				result = "";
			} else {
				String pattern = Preferences.getBundle().getString("markupparser.error.plugininsertion");
				result = MessageFormat.format(pattern, //
						wikiContext.getRealPage().getWiki(), // 
						wikiContext.getRealPage().getName(), // 
						e.getMessage());
			}
		}

		return result;
	}

	/** {@inheritDoc} */
	@Override
	public void executeParse() throws PluginException {
		Engine engine = RWC.INSTANCE.getEngine();
		PluginManager pluginManager = engine.getManager(PluginManager.class);
		if (pluginManager.isEnabledPlugins()) {
			WikiPlugin plugin = pluginManager.getWikiPlugin(getPluginName());
			if (plugin instanceof ParserStagePlugin parserStagePlugin) {
				Map<String, String> params = getParameters();
				parserStagePlugin.executeParser(this, params);
			}
		}
	}

	/**
	 * Parses a plugin invocation and returns a DOM element.
	 * @param commandline The line to parse
	 * @param pos         The position in the stream parsing.
	 *
	 * @return A DOM element
	 * @throws PluginException If plugin invocation is faulty
	 */
	public static PluginContent parsePluginLine(String commandline, int pos)
			throws PluginException {
		Engine engine = RWC.INSTANCE.getEngine();
		PluginManager pluginManager = engine.getManager(PluginManager.class);
		PatternMatcher matcher = new Perl5Matcher();

		try {
			if (matcher.contains(commandline, pluginManager.getPluginPattern())) {
				MatchResult res = matcher.getMatch();
				String plugin = res.group(2);
				String args = commandline.substring(res.endOffset(0),
						commandline.length() - (commandline.charAt(commandline.length() - 1) == '}' ? 1 : 0));
				Map<String, String> arglist = pluginManager.parseArgs(args);

				// set wikitext bounds of plugin as '_bounds' parameter, e.g., [345,396]
				if (pos != -1) {
					int end = pos + commandline.length() + 2;
					String bounds = pos + "|" + end;
					arglist.put(PluginManager.PARAM_BOUNDS, bounds);
				}

				return new PluginContent(plugin, arglist);
			}
		} catch (ClassCastException e) {
			log.error("Invalid type offered in parsing plugin arguments.", e);
			throw new InternalWikiException("Oops, someone offered !String!", e);
		} catch (NoSuchElementException e) {
			String msg = "Missing parameter in plugin definition: " + commandline;
			log.warn(msg, e);
			throw new PluginException(msg);
		} catch (IOException e) {
			String msg = "Zyrf.  Problems with parsing arguments: " + commandline;
			log.warn(msg, e);
			throw new PluginException(msg);
		}

		return null;
	}

}
